Add json-rpc docs for ChainGetFinalizedTipSet #2422
Conversation
Added documentation for ChainGetFinalizedTipSet API. This is a copy/paste from https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-methods-v1-stable.md#ChainGetFinalizedTipSet
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for the ChainGetFinalizedTipSet JSON-RPC API method, providing comprehensive details about its functionality, permissions, inputs, and response format. The documentation explains that this method returns the latest finalized tipset using F3 consensus or falls back to Expected Consensus finality.
- Added complete API documentation including method description, permissions, and response schema
- Included detailed JSON response example showing the structure of a finalized tipset
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| This is the tipset at the end of the last finalized round and can be used | ||
| for follow-up querying of the chain state with the assurance that the | ||
| state will not change. | ||
| If F3 is operational and finalizing in this node. If not, it will fall back |
There was a problem hiding this comment.
The sentence on line 299 is incomplete. It should read 'This method returns the finalized tipset if F3 is operational and finalizing in this node.'
| If F3 is operational and finalizing in this node. If not, it will fall back | |
| This method returns the finalized tipset if F3 is operational and finalizing in this node. If not, it will fall back |
Copilot uses AI. Check for mistakes.
|
I thought json-rpc API documentation in the repo was automated but then I didn't see where that was done... @rjan90 or @lanzafame : let me know if I should do this differently. |
|
I don't think it occurs within this repo. @rjan90 any idea? |
|
My knowledge of how the Filecoin documentation is structure is limited, but from my understanding I do not think either the Lotus or Filecoin docs sites has had automated API documentation. |
|
@lanzafame change here looks good to me. |
I'm remembering now. I believe there is automation for filecoin-projects/lotus-docs to pull in whatever is done in this repo. Ideally these RPC docs would get autogenerated by code or other assets in Lotus, but I don't think anyone has the bandwidth for that currently. As a result, I propose we just go the manual route for now so that F3 blog entries, etc. can link to an official API doc. @lanzafame : are you ok to merge? I see there are broken links unrelated to my change. |
|
@lanzafame : I'm hoping to publish a f3-related blog post soon and I'd like to like to this API definition. Are you ok to merge? |
|
@lanzafame : I'll plan to merge this 2025-10-07 Pacific time if I don't hear anything otherwise. |
Added documentation for ChainGetFinalizedTipSet API. This is a copy/paste from https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-methods-v1-stable.md#ChainGetFinalizedTipSet